The command line Syntax of javadoc is as follows:Javadoc [options] [packagenames] [sourcefiles] [@ files]Parameters can be arranged in any order. The following describes these parameters and related content:• Packagenames package list. This option
Javadoc is a technology provided by sun, which extracts classes, methods, members, and other annotations from the program source code to form an API help document supporting the source code. The Javadoc command is used to generate your own API
Javadoc annotation specification and javadoc Annotation
Javadoc comments1. Java documentation// Comment a row/* ...... */Annotate several rows/**... */Annotate several lines and write them into the javadoc document.The multiple lines of such
Javadoc Make notesA. Java documentationComment Line*/* ... * * Comment several lines/** ... * * Comment several lines and write to Javadoc documentUsually the multiline notation of this comment is as follows:/*** .........* .........*/javadoc-d
We know there are three types of comment statements in Java:1.//used for single-line comments. 2./*...*/For multi-line annotations, from/*start, to*/end, cannot be nested. 3./**...*/is a comment statement that is unique to support the JDK tool
Objective:
1. The generated API document is a file named index.html
2.javadoc only process document source files in classes, interfaces, methods, member variables, constructors, internal classes of comments, ignoring comments elsewhere
The 3.javadoc
One. Right-click the project, select ExportTwo. Select the Javadoc below JavaThree. Create Javadoc for members with visibility explanationPrivate all classes and members are generatedThe package is generated in addition to private classes and
Correct use posture of the Javadoc command
javadoc -d apidoc -windowtitle Testing -doctitle ‘The API of javadoc‘ -header ‘My class‘ -charset UTF-8 -author -version *.java
Attention
-author and-version are used because Javadoc does not
Writing comments for code has been a bit of a problem for most developers. Current developers can accept the idea of writing annotations for program maintainability and readability, but many developers still don't have answers about where to write
Usage: Javadoc [options] [packagenames] [sourcefiles] [@files]-overview Reading an overview document from an HTML file-public Show only public classes and members-protected display of Protected/public classes and members (default values)-package
The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion;
products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the
content of the page makes you feel confusing, please write us an email, we will handle the problem
within 5 days after receiving your email.
If you find any instances of plagiarism from the community, please send an email to:
info-contact@alibabacloud.com
and provide relevant evidence. A staff member will contact you within 5 working days.